Список районов

Запрос позволяет получить информацию обо всех доступных районах поездок клиента.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions/list? 
limit=<количество записей>
&offset=<количество пропускаемых записей>

GET https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions? 
limit=<количество записей>
&offset=<количество пропускаемых записей>

Заголовки запроса

• Authorization: Bearer <OAuth-токен>
  Процесс получения токена описан в разделе Начало работы.

• X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос может содержать следующие необязательные аргументы:

• limit — количество выводимых записей. При отсутствии данного параметра возвращается информация о первых 100 записях.

• offset — количество пропускаемых записей. При отсутствии данного параметра возвращается информация начиная с первой записи.

Записи в ответе сортируются по дате и времени последнего обновления.

Максимальный рекомендованный размер справочника — до 10 000 записей.

Описание полей ответа

В ответе могут содержаться следующие поля:

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions/list?limit=50
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
    "limit": 50,
    "offset": 0,
    "items": [
      {
        "id": "0081...6917",
        "geo": {
          "center": [
            72.368212,
            54.989342
          ],
          "radius": 500
        },
        "geo_type": "circle",
        "name": "Офис 1"
      },
      {
        "id": "b45e...f0de",
        "geo": {
          "center": [
            37.642639,
            55.734894
          ],
          "radius": 200
        },
        "geo_type": "circle",
        "name": "Офис 2"
      }
    ]
  }

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

• 200 — запрос выполнен успешно.
• 400 — в запросе был передан неизвестный параметр.
• 401 — был передан неверный OAuth-токен.
• 403 — у клиента не хватает прав на выполнение данного запроса.
  • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
  • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.